Fix typos, add usage example, clarify tests and contributing #343

Bano733-code · 2025-11-28T04:52:34Z

Thank you for your contribution!
If you have any questions about your PR, or need help completing it, you can ping the maintainers of this repository, who will be happy to help if they can find time.

You can optionally use the following checklist when you work on your PR:

I have updated any relevant documentation and docstrings.
I have added unit tests, and the CodeCov bot shows tests cover my new code.
I have mentioned my changes in the CHANGELOG.md file.

kescobo · 2025-12-01T13:16:30Z

Hi @Bano733, thanks for the contribution! Please forgive the skepticism, but I'm a bit wary of encouraging minor tweaks like this with no prior discussion, two accounts with little history, and a failure to fill out the simple template in the PR comment. It smacks of low-effort AI spam.

If I'm wrong, please do set me straight, we are always happy to welcome new contributors.

codecov · 2025-12-01T13:47:32Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.75%. Comparing base (95d9218) to head (62d9004).
⚠️ Report is 26 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #343      +/-   ##
==========================================
+ Coverage   90.87%   91.75%   +0.88%     
==========================================
  Files          31       29       -2     
  Lines        2400     2827     +427     
==========================================
+ Hits         2181     2594     +413     
- Misses        219      233      +14

Flag	Coverage Δ
unittests	`91.75% <ø> (+0.88%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Bano733 · 2025-12-01T14:37:01Z

Hi @kescobo, thank you for the feedback — and totally understand the concern. I’m a new contributor preparing for Outreachy, and BioJulia is the first Julia ecosystem I’m contributing to. This PR was my attempt to start with small documentation improvements and understand the workflow. I did not mean to skip the template — that was my mistake, and I can update the PR if needed. Happy to discuss the change, improve it, or close it if it’s not useful. Thanks again for guiding new contributors like me!

…

On Mon, Dec 1, 2025, 6:47 PM codecov[bot] ***@***.***> wrote: *codecov[bot]* left a comment (BioJulia/BioSequences.jl#343) <#343 (comment)> Codecov <https://app.codecov.io/gh/BioJulia/BioSequences.jl/pull/343?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BioJulia> Report ✅ All modified and coverable lines are covered by tests. ✅ Project coverage is 91.75%. Comparing base (95d9218 <https://app.codecov.io/gh/BioJulia/BioSequences.jl/commit/95d9218dabd50be36700760713796e9711a425a5?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BioJulia>) to head (83ab7ca <https://app.codecov.io/gh/BioJulia/BioSequences.jl/commit/83ab7ca26d98d698aa46b302f0210c1f26c56b96?dropdown=coverage&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BioJulia> ). ⚠️ Report is 25 commits behind head on master. Additional details and impacted files @@ Coverage Diff @@## master #343 +/- ## ==========================================+ Coverage 90.87% 91.75% +0.88% ========================================== Files 31 29 -2 Lines 2400 2827 +427 ==========================================+ Hits 2181 2594 +413 - Misses 219 233 +14 Flag <https://app.codecov.io/gh/BioJulia/BioSequences.jl/pull/343/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BioJulia> Coverage Δ unittests <https://app.codecov.io/gh/BioJulia/BioSequences.jl/pull/343/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BioJulia> 91.75% <ø> (+0.88%) ⬆️ Flags with carried forward coverage won't be shown. Click here <https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BioJulia#carryforward-flags-in-the-pull-request-comment> to find out more. ☔ View full report in Codecov by Sentry <https://app.codecov.io/gh/BioJulia/BioSequences.jl/pull/343?dropdown=coverage&src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BioJulia> . 📢 Have feedback on the report? Share it here <https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=BioJulia> . 🚀 New features to boost your workflow: - ❄️ Test Analytics <https://docs.codecov.com/docs/test-analytics>: Detect flaky tests, report on failures, and find test suite problems. — Reply to this email directly, view it on GitHub <#343 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BLRFGWHKGTEBJKMVJWNAJPT37RBITAVCNFSM6AAAAACNN462X2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTKOJWGY2DENBVG4> . You are receiving this because you were mentioned.Message ID: ***@***.***>

kescobo · 2025-12-01T15:14:41Z

Great! Thanks for the rapid response! We are definitely happy to accept simple PRs like this, thanks for being understanding any the red flags. Will try to get a more substantive comment to you by EOD

README.md

kescobo · 2025-12-01T23:09:59Z

Test failure (obviously) unrelated

Co-authored-by: Kevin Bonham <[email protected]>

Bano733-code · 2025-12-02T01:44:27Z

Thanks for the feedback! I fixed the code block formatting and added the canonical dna"ACGTACGT" example as suggested. I also removed the duplicate line in the contributing section. Let me know if you want any further adjustments.

Bano733-code · 2025-12-04T15:33:50Z

Thank you for the review and merge! I appreciate the feedback and look forward to contributing again.

…

On Thu, Dec 4, 2025, 8:29 PM Kevin Bonham ***@***.***> wrote: Merged #343 <#343> into master. — Reply to this email directly, view it on GitHub <#343 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BQ4RRS3LOWLEK6CXYWBVSSL4ABHOBAVCNFSM6AAAAACNN462X2VHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMRRGM3DENZZGE2TOMQ> . You are receiving this because you authored the thread.Message ID: ***@***.***>

Fix typos, add usage example, clarify tests and contributing

83ab7ca

kescobo added the documentation label Dec 1, 2025

kescobo requested changes Dec 1, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

Bano733-code and others added 2 commits December 2, 2025 06:37

Update README.md

845eeef

Co-authored-by: Kevin Bonham <[email protected]>

Update README.md

62d9004

Co-authored-by: Kevin Bonham <[email protected]>

kescobo approved these changes Dec 4, 2025

View reviewed changes

kescobo merged commit 2c53968 into BioJulia:master Dec 4, 2025
19 of 20 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix typos, add usage example, clarify tests and contributing #343

Fix typos, add usage example, clarify tests and contributing #343

Bano733-code commented Nov 28, 2025

Uh oh!

kescobo commented Dec 1, 2025

Uh oh!

codecov bot commented Dec 1, 2025 •

edited

Loading

Uh oh!

Bano733 commented Dec 1, 2025 via email

Uh oh!

kescobo commented Dec 1, 2025

Uh oh!

Uh oh!

Uh oh!

kescobo commented Dec 1, 2025

Uh oh!

Bano733-code commented Dec 2, 2025

Uh oh!

Uh oh!

Bano733-code commented Dec 4, 2025 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Fix typos, add usage example, clarify tests and contributing #343

Fix typos, add usage example, clarify tests and contributing #343

Conversation

Bano733-code commented Nov 28, 2025

Uh oh!

kescobo commented Dec 1, 2025

Uh oh!

codecov bot commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Bano733 commented Dec 1, 2025 via email

Uh oh!

kescobo commented Dec 1, 2025

Uh oh!

Uh oh!

Uh oh!

kescobo commented Dec 1, 2025

Uh oh!

Bano733-code commented Dec 2, 2025

Uh oh!

Uh oh!

Bano733-code commented Dec 4, 2025 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Dec 1, 2025 •

edited

Loading